<HTML>
<HEAD>
<TITLE>Extractor README</TITLE>
</HEAD>

<BODY BGCOLOR="#ffffff">
<MAP NAME="banner_top">
<AREA SHAPE="rect" COORDS="588,14,620,40" 
    HREF="http://www.iit.nrc.ca/english.html">
<AREA SHAPE="rect" COORDS="538,14,583,37" 
    HREF="http://www.nrc.ca/corporate/english/">
<AREA SHAPE="rect" COORDS="86,4,421,37" 
    HREF="http://www.iit.nrc.ca/II_public/index.html">
</MAP>

<IMG SRC="banner_top.jpg" width="620" height="37" 
    alt="II Group Banner" USEMAP="#banner_top"
ISMAP border="0"><BR><IMG SRC="banner_extractor.jpg" width="217" 
    heigth="49" alt="Extractor">

<FONT COLOR="#400080"><H1>Extractor README</H1></FONT>

<SMALL><I>Extractor 7.2, Revised December 4, 2001</I></SMALL><BR>
<SMALL><I>Copyright &copy; 2001, National Research Council of Canada</I></SMALL>

<HR>

<P>
Extractor takes a text file as input and
generates a list of key words and a list of key sentences as output. <BR>
Extractor was developed by the Interactive Information Group
of the National Research Council of Canada. <BR>
This is the README file for the Extractor Demonstration Package.
</P>

<MENU>
<LI> <A HREF=http://extractor.iit.nrc.ca/licence.html>
Licence for the Extractor Demonstration Package</A>
<LI> <A HREF=#use>
How to Use the Extractor Demonstration Package</A>
<LI> <A HREF=#files>
Files in the Extractor Demonstration Package</A>
<LI> <A HREF=http://extractor.iit.nrc.ca/jair/keyphrases/>
A Sample Application of Extractor</A>
<LI> <A HREF=api.html>
The Extractor API (Application Program Interface)</A>
<LI> <A HREF=usage.html>
How to Use the Extractor API</A>
<LI> <A HREF=history.html>
Extractor Version Release History</A>
<LI> <A HREF=http://extractor.iit.nrc.ca/>
The Extractor Home Page</A>
<LI> <A HREF=http://extractor.iit.nrc.ca/faq.html>
Extractor FAQ</A>
<LI> <A HREF=http://ai.iit.nrc.ca/II_public/>
The Interactive Information Group Home Page</A>
</MENU>

<HR>

<A NAME=use>
<FONT COLOR="#400080"><H2>How to Use the Extractor Demonstration Package</H2></FONT>

<P>
You can quickly experiment with applying Extractor to your own documents,
by executing <CODE>test_api.exe</CODE>. To execute <CODE>test_api.exe</CODE>,
first start an MS-DOS Command Prompt window. You should be able to start an
MS-DOS window from somewhere on your "Start" menu in Windows 95/98/NT.
Then "cd" to the directory where you stored the Extractor Demonstration Package
and enter <CODE>test_api.exe</CODE>. For example, if you created a directory
called "Extractor" and downloaded the Extractor Demonstration Package into
this directory, then you could execute <CODE>test_api.exe</CODE> as follows:
</P>

<PRE>
        C:\Windows> cd \Extractor
	C:\Extractor> test_api
</PRE>

<P>
Note that <CODE>test_api.exe</CODE> was not designed to be run by double 
clicking on the file icon in the Windows file manager. It must be run
from within an MS-DOS window. Also note that <CODE>test_api.exe</CODE>
uses <CODE>extr_api.dll</CODE>, so <CODE>extr_api.dll</CODE> must be
in your <CODE>path</CODE> or in the same directory as <CODE>test_api.exe</CODE>.
</P>

<P>
For convenience, you may wish to have <CODE>test_api.exe</CODE> in
your <CODE>path</CODE>. If <CODE>test_api.exe</CODE> and
<CODE>extr_api.dll</CODE> are in a directory called "Extractor", then
you can add them to your path as follows:
</P>

<PRE>
        C:\Windows> path %path%;"C:\Extractor\"
        C:\Windows> test_api
</PRE>

<P>
You can do this each time you open an MS-DOS window for running
Extractor, or you can put this line in your <CODE>autoexec.bat</CODE>
file.
</P>

<P>
If you are a software developer, you may wish to experiment with 
embedding Extractor in your own software. You can do this with the
Extractor API, as described in the 
<A HREF=api.html>
documentation for the API.</A> The DLL will only function for a
limited trial period. If you wish to obtain a DLL that has no
time limit, then please contact us to arrange a licence.
</P>

<P>
The files <CODE>extr_api.dll</CODE> and <CODE>test_api.exe</CODE>
were generated with Microsoft Visual C++ 6.0. <CODE>extr_api.dll</CODE>
was compiled as a multi-threaded Win32 DLL. <CODE>test_api.exe</CODE>
was compiled as a multi-threaded Win32 executable file. To
compile <CODE>test_api.c</CODE>, Visual C++ 6.0 requires
<CODE>extr_api.lib</CODE> and <CODE>extr_api.h</CODE>. To
run <CODE>test_api.exe</CODE>, <CODE>extr_api.dll</CODE> must
be available.

<HR>

<A NAME=files>
<FONT COLOR="#400080"><H2>Files in the Extractor Demonstration Package</H2></FONT>

<P>
This file (readme.html) is part of a demonstration package, which
includes the following files:
</P>

<DL>

<DT> <A HREF=api.html><B><CODE>api.html</CODE></B></A>
<DD> This file contains a description of the API (Application Program Interface) for
Extractor. With this API, Extractor can be embedded in your software. 

<DT> <B><CODE>extr_api.dll</CODE></B>
<DD> This is the DLL (Dynamically Linked Library) for Extractor. When running
<CODE>test_api.exe</CODE>, the DLL should be either in your <CODE>path</CODE>
or in the same directory as <CODE>test_api.exe</CODE>. This demonstration DLL
will cease to function at the end of the trial period.

<DT> <A HREF=extr_api.h><B><CODE>extr_api.h</CODE></B></A>
<DD> This is the header file for the DLL. It should be included in any code
that you write that uses the DLL. See <CODE>test_api.c</CODE> for example.

<DT> <B><CODE>extr_api.lib</CODE></B>
<DD> This file is used when compiling. It tells the compiler how to link
the DLL into your software.

<DT> <A HREF=history.html><B><CODE>history.html</CODE></B></A>
<DD> This is a history of the releases of the versions of Extractor.

<DT> <B><CODE>readme.html</CODE></B>
<DD> This is the file you are reading now.

<DT> <A HREF=test_api.c><B><CODE>test_api.c</CODE></B></A>
<DD> This is a sample of a program that uses the Extractor DLL.

<DT> <B><CODE>test_api.exe</CODE></B>
<DD> This is the file that results when <CODE>test_api.c</CODE> is
compiled. Try running it! Note that it works in conjunction with 
<CODE>extr_api.dll</CODE>.

<DT> <A HREF=threads.html><B><CODE>threads.html</CODE></B></A>
<DD> A note about using threads with the Extractor API.

<DT> <A HREF=usage.html><B><CODE>usage.html</CODE></B></A>
<DD> This file gives suggestions for using the Extractor API.

</DL>

<HR>

<CENTER>
<table border="1" bgcolor="#ccccff">
<tr><td><font size=2>
[ <a href="http://extractor.iit.nrc.ca/">Extractor Home</a> |
<A HREF="http://www.iit.nrc.ca/II_public/french.html">Fran&ccedil;ais</a> |
<A HREF="http://www.iit.nrc.ca/english.html">IIT</A> |
<A HREF="http://www.iit.nrc.ca/II_public/index.html">II Group</A> |
<A HREF="http://www.nrc.ca/corporate/english/">NRC</A> |
<A HREF="http://ai.iit.nrc.ca/search.html">Search</A> |
<A HREF="mailto:Peter.Turney@nrc.ca">Feedback</A> ]
[ <I>Updated</I>: December 4, 2001 ]</font size=2></td></tr>
</table>

</BODY>
</HTML>
